API Endpoints Documentation

Generated on: 2026-01-08T10:40:21.661Z

Table of Contents

ad-events

AdEventController

📁 File: src/ad-events/ad-events.controller.ts

Base Path: ad

Method Path Handler Location Params Query Body Return Type Description
POST /ad/conversions trackContentView L43-74 - - TrackContentViewRequest - -
GET /ad/trackings getPixelRecord L76-80 - - - - -
GET /ad/admin/trackings getPixelRecordByAdmin L82-87 - string - - -
POST /ad/trackings createPixelRecord L89-93 - - CreateAdPixelRequest - -
PUT /ad/trackings/:id updatePixelRecord L95-106 id: string - UpdateAdPixelRequest - -
DELETE /ad/trackings/:id deletePixelRecord L108-115 id: string - - - -
POST /ad/admin/trackings createPixelRecordByAdmin L117-125 - - AdminCreateAdPixelRequest - -
PUT /ad/admin/trackings/:id updatePixelRecordByAdmin L127-139 id: string - AdminUpdateAdPixelRequest - -
DELETE /ad/admin/trackings/:id deletePixelRecordByAdmin L141-152 id: string - AdminDeleteAdPixelRequest - -

ai

AIController

📁 File: src/ai/ai.controller.ts

Base Path: ai

Method Path Handler Location Params Query Body Return Type Description
POST /ai/generate-variants generateVariants L39-46 - - LLMVariantGenerationRequest Promise -
POST /ai/generate-description generateDescription L48-55 - - ProductDescriptionRequest Promise -
POST /ai/generate-post generatePost L57-72 - string PostGenerationRequest Promise<PostGenerationResponse PostGenerationJobResponse> -
GET /ai/generate-post/:jobId/status getPostGenerationJobStatus L74-79 jobId: string - - Promise -

auth

AuthController

📁 File: src/auth/auth.controller.ts

Base Path: auth

Method Path Handler Location Params Query Body Return Type Description
GET /auth/reset-issued assertResetIssued L73-76 - ResetIssuedRequest - - -
GET /auth/validate-email validateEmail L83-88 - EmailRequest - - -
POST /auth/password-email sendChangePasswordEmail L96-104 - - EmailRequest - -
POST /auth/password-sms sendChangePasswordSms L112-129 - - PhoneNumberRequest - -
PUT /auth/password updateUserPassword L136-139 - - UpdateByPasswordRequest - -
POST /auth/sign-in loginByPassword L141-147 - - LoginByPasswordRequest - -
POST /auth/test/sign-in loginByPasswordForTest L154-163 - - LoginByPasswordRequest - -
POST /auth/verify-duplicate verifyDuplicateEmailOrPhoneNumber L172-186 - - VerifyDuplicateEmailOrPhoneNumberRequest - -
GET /auth/verify-code verifyCode L195-241 - ValidateCodeRequest - - -
GET /auth/validate-token validateToken L248-259 - string - - -
GET /auth/verify-code/reset-password verifyCodeToResetPassword L269-281 - ValidateCodeRequest - - -
POST /auth/code sendValidateCode L291-306 - - SendCodeRequest - -
POST /auth/auto/code autoSendValidateCode L317-340 - - - - -
POST /auth/guest-login loginForGuest L349-352 - - LoginForGuestRequest Promise -
POST /auth/consumer-login loginForConsumer L362-375 - - ConsumerLoginRequest - -
POST /auth/promoter-login loginForPromoter L385-394 - - PromoterLoginRequest - -
POST /auth/merchant-login loginForMerchant L404-413 - - MerchantLoginRequest - -
POST /auth/promoter-signup signUpForPromoter L423-454 - - PromoterSignupRequest - -
POST /auth/merchant-signup signUpForMerchant L465-533 - - MerchantSignupRequest - -
POST /auth/order-login orderLogin L545-594 - - OrderLoginRequest - -
DELETE /auth/users deleteAuthUser L596-602 - - { email: string } - -
PUT /auth/admin/users/:userId/password updateUserPasswordByAdmin L604-622 userId: string - { password: string } - -
GET /auth/refreshToken refreshToken L633-669 - RefreshTokenRequest - Promise -
GET /auth/admin/users/:userId/refresh-token/:impersonationUserId generateFreshTokenFromAdmin L712-731 userId: string, impersonationUserId: string - - - -
POST /auth/shop-admin/login shopAdminLogin L739-751 - - ShopAdminLoginRequest - -
POST /auth/shop-admin/switch switchShop L760-764 - - SwitchShopRequest - -

campaigns

CampaignController

📁 File: src/campaigns/campaigns.controller.ts

Base Path: campaigns

Method Path Handler Location Params Query Body Return Type Description
POST /campaigns/ createCampaign L33-37 - - CreateCampaignDto - -
POST /campaigns/duplicate duplicateCampaign L39-43 - - DuplicateCampaignDto - -
GET /campaigns/ listCampaigns L46-54 - ListCampaignsDto - - -
GET /campaigns/edit/:id getDetailForEdit L57-61 id: string - - - -
GET /campaigns/:id getDetail L64-68 id: string - - - -
GET /campaigns/recipients/:id getAllRecipients L71-83 id: string GetRecipientsDto - - -
PUT /campaigns/:id updateCampaign L86-93 id: string - UpdateCampaignDto - -
DELETE /campaigns/:id deleteCampaign L96-100 id: string - - - -
POST /campaigns/test/sms sendTestSms L103-107 - - TestSmsDto - -
POST /campaigns/test/email sendTestEmail L110-114 - - TestEmailDto - -
GET /campaigns/select/recipients-count getFollowerCountByPermission L116-137 - string - - -
GET /campaigns/select/recipients-list listSubscriptionByPermission L139-165 - string - - -
POST /campaigns/save-recipients syncCampaignRecipients L167-171 - - AddRecipientsDto - -
POST /campaigns/send-campaign sendCampaign L173-176 - - SendSmsOrEmailDto - -

cart

CartController

📁 File: src/cart/cart.controller.ts

Base Path: cart

Method Path Handler Location Params Query Body Return Type Description
POST /cart/promoter updateCartForPromoter L37-53 - - CreateCartItemForPromoterRequest - -
PUT /cart/selected updateSelected L55-75 - - UpdateSeletedRequest - -
PUT /cart/ updateCart L77-99 - - UpdateCartRequest - -
GET /cart/ getCartItems L151-183 - GetCartRequest - - -

catalog/controllers

EventCatalogController

📁 File: src/catalog/controllers/event-catalog.controller.ts

Base Path: catalog/event

Method Path Handler Location Params Query Body Return Type Description
PATCH /catalog/event/co-selling-defaults updateCoSellingDefaults L24-28 - - UpdateCoSellingDefaultsDto - -
GET /catalog/event/default getDefaultCatalog L35-51 - - - - -

channel

ChannelController

📁 File: src/channel/channel.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
GET /app/shopify/auth/install beginShopifyOAuth L51-92 - Record - - -
GET /app/shopify/auth/callback shopifyOAuthCallback L118-188 - Record - - -
POST /app/shopify/shops/:shop_id/connect connectShopify L190-209 shop_id: string - - - -
POST /app/shopify/shops/:shop_id/disconnect disconnectShopify L211-227 shop_id: string - - - -
GET /app/shopify/shops/self getProductDashboardOfShop L229-286 - - - - -
POST /app/shopify/webhook/app/uninstalled appUninstalled L288-310 - - - - -
POST /app/shopify/webhook/product_listings/add createProductListingWebhook L312-328 - - { product_listing: ShopifyProduct } - -
POST /app/shopify/webhook/product_listings/update updateProductListingWebhook L330-346 - - { product_listing: ShopifyProduct } - -
POST /app/shopify/webhook/product_listings/remove deleteProductListingWebhook L348-366 - - { product_listing: { product_id: number } } - -
POST /merchant/product/webhook/create createProductWebhook L368-392 - - KnownKeys - -
POST /merchant/product/webhook/update updateProductWebhook L394-419 - - KnownKeys - -
POST /merchant/product/webhook/delete deleteProductWebhook L421-439 - - { id: number } - -
POST /app/shopify/webhook/customers/data_request viewStoredCustomerData L441-455 - - - - -
POST /app/shopify/webhook/customers/redact deleteCustomerData L457-471 - - - - -
POST /app/shopify/webhook/shop/redact deleteShopData L473-487 - - - - -

cloudinary

CloudinaryController

📁 File: src/cloudinary/cloudinary.controller.ts

Base Path: cloudinary

Method Path Handler Location Params Query Body Return Type Description
GET /cloudinary/pre-signed PreSignedUrl L22-31 - CloudinaryFolderType - - -
DELETE /cloudinary/destroy destroyAssets L33-38 - - DestroyCloudinaryAssets - -

contract

AdminCuratorContractController

📁 File: src/contract/admin-curator-contract.controller.ts

Base Path: admin/curator-contract

Method Path Handler Location Params Query Body Return Type Description
POST /admin/curator-contract/:contractId/stripe/setup-intent createSetupIntentFromAdmin L46-54 contractId: string - - - -
POST /admin/curator-contract/:contractId/payments addPaymentMethodFromAdmin L56-69 contractId: string - CuratorAddPaymentMethodRequest - -
GET /admin/curator-contract/ queryContractsAdmin L71-77 - CuratorQueryRequest - - -
GET /admin/curator-contract/:contractId/history queryHistoryContracts L79-92 contractId: string PaginationInfo - - -
GET /admin/curator-contract/:contractId/payments queryConsumerAllPayments L94-102 contractId: string - - - -
GET /admin/curator-contract/:contractId queryContractDetailsAdmin L104-110 contractId: string string - - -
PUT /admin/curator-contract/:contractId/address updateAddressByAdmin L112-126 contractId: string - AddressRequest - -
PUT /admin/curator-contract/:contractId/contract-order updateContractOrderByAdmin L128-142 contractId: string - CuratorUpdateContractOrderRequest - -
PUT /admin/curator-contract/:contractId updateContractByMerchant L144-160 contractId: string - CuratorUpdateContractRequest - -

ContractCuratorController

📁 File: src/contract/contract-curator.controller.ts

Base Path: contract/curator

Method Path Handler Location Params Query Body Return Type Description
GET /contract/curator/ queryContracts L32-39 - CuratorQueryRequest - - -
GET /contract/curator/statistic/subscription getSubscriptionStatistics L41-45 - - - - -
GET /contract/curator/:consumerId/payments qryConsumerAllPayments L47-54 consumerId: string - - - -
POST /contract/curator/:consumerId/:contractId/payments addPaymentMethodFromMerchant L56-69 consumerId: string, contractId: string - CuratorAddPaymentMethodRequest - -
POST /contract/curator/:consumerId/stripe/setup-intent createSetupIntentFromMerchant L71-78 consumerId: string - - - -
GET /contract/curator/:consumerId/:contractId qryContractDetails L80-91 consumerId: string, contractId: string - - - -
PUT /contract/curator/:consumerId/:contractId updateContractByMerchant L103-119 contractId: string, consumerId: string - CuratorUpdateContractRequest - -
PUT /contract/curator/:consumerId/:contractId/address updateAddressByMerchant L121-134 consumerId: string, contractId: string - AddressRequest - -
PUT /contract/curator/:consumerId/:contractId/:contractOrderId updateContractOrderByMerchant L145-162 consumerId: string, contractId: string, contractOrderId: string - CuratorUpdateContractOrderRequest - -
GET /contract/curator/:consumerId/:contractId/history qryHistoryContracts L164-177 contractId: string, consumerId: string PaginationInfo - - -

ContractController

📁 File: src/contract/contract.controller.ts

Base Path: users/self/contracts

Method Path Handler Location Params Query Body Return Type Description
GET /users/self/contracts/:contractId/history getHistoryOrders L31-40 contractId: string PaginationInfo - - -
GET /users/self/contracts/address getAddressInUse L48-66 - string - - -
GET /users/self/contracts/payment getPaymentInUse L75-92 - string - - -
GET /users/self/contracts/:contractId getSingleContract L94-99 contractId: string - - - -
GET /users/self/contracts/ getSummaryContracts L101-112 - ContractPageInfoRequest - - -
PUT /users/self/contracts/:contractId updateContract L114-127 contractId: string - UpdateContractRequest - -
PUT /users/self/contracts/:contractId/contract-orders/:contractOrderId updateContractOrder L129-143 contractId: string, contractOrderId: string - UpdateContractOrderRequest - -
GET /users/self/contracts/user/address/:addressId getAddressInUseByProcessing L152-176 addressId: string - - - -
PUT /users/self/contracts/user/address updateAllContractByAddress L178-191 - - UpdateContractRequest - -

credit

PointController

📁 File: src/credit/point.controller.ts

Base Path: point

Method Path Handler Location Params Query Body Return Type Description
PUT /point/consumer creditPut L29-33 - - CreditPutRequest - -
GET /point/consumer/alias getConsumerAlias L35-39 - string - - -
GET /point/consumer/summary getConsumerBalance L41-46 - string - - -
GET /point/consumer/earn-history getConsumerEarnHistory L48-68 - number - - -
GET /point/consumer/used-history getConsumerConsumeHistory L70-91 - number - - -
GET /point/promoter/summary getPromoterSummary L93-102 - - - - -
POST /point/promoter/rule createPromoterCreditRule L104-112 - - CreditRuleRequest - -
GET /point/promoter/rule getPromoterCreditRule L114-124 - CreditRecordType - - -
GET /point/promoter/distribute-history getPromoterCreditHistory L126-146 - number - - -
GET /point/promoter/used-history getPromoterCreditConsumeHistory L148-169 - number - - -

default

DefaultController

📁 File: src/default/default.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
GET / check L31-38 - - - - -
GET /health healthCheck L44-71 - - - - -

earning-share

EarningShareController

📁 File: src/earning-share/earning-share.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
GET /users/me/recipient-earning-shares queryEarningSharesByRecipient L36-49 - ListEarningShareByRecipientReq - Promise -
GET /users/me/recipient-earning-shares/:earningShareId getEarningShareById L59-80 earningShareId: string - - Promise -

earning-share/config

EarningShareConfigController

📁 File: src/earning-share/config/earning-share-config.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
GET /users/me/earning-share-configs queryEarningShareConfigsBySharer L31-43 - - - Promise -
GET /users/me/recipient-earning-share-configs queryEarningShareConfigsByRecipient L45-61 - - - Promise -
POST /users/me/earning-share-configs createEarningShareConfig L63-80 - - CreateEarningShareConfigReq Promise -
PUT /users/me/earning-share-configs/:configId updateEarningShareConfig L82-100 configId: string - UpdateEarningShareConfigReq Promise -
DELETE /users/me/earning-share-configs/:configId deleteEarningShareConfig L102-108 configId: string - - Promise -

earnings

EarningsController

📁 File: src/earnings/earnings.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
GET /earnings-merchant-orders queryEarningsMerchantOrders L23-37 - QueryEarningMerchantOrderReq - Promise -
GET /earnings-promoter-orders queryEarningsPromoterOrders L39-53 - QueryEarningsPromoterOrdersReq - - -

feature-setting

FeatureSettingController

📁 File: src/feature-setting/feature-setting.controller.ts

Base Path: feature-setting

Method Path Handler Location Params Query Body Return Type Description
PATCH /feature-setting/promoter/:featureName promoterSetting L49-61 featureName: FeatureName - ExtendSettingRequest - -
POST /feature-setting/promoter promoterSettingPost L63-70 - - PromoterSettingUpsertRequest - -
GET /feature-setting/promoter getPromoterSettingAll L72-102 - PromoterSettingRequest - Promise>> -
GET /feature-setting/promoter/:featureName getPromoterSetting L104-116 featureName: FeatureName - - - -
GET /feature-setting/feature-whitelist whitelist L121-131 - string - - -
GET /feature-setting/consumer/:featureName getConsumerSettingByName L133-144 featureName: FeatureName ConsumerSettingRequest - - -
GET /feature-setting/consumer getConsumerSetting L146-183 - ConsumerSettingRequest - - -
GET /feature-setting/consumer-public getPublicConsumerSetting L185-211 - ConsumerSettingRequest - - -
PATCH /feature-setting/consumer/:featureName consumerSetting L213-224 featureName: FeatureName - ExtendSettingRequest - -
POST /feature-setting/consumer consumerSettingOld L226-236 - - FeatureNameAndPromoterIdRequest - -
GET /feature-setting/merchant-signup getMerchantSignup L243-251 - string - - -
GET /feature-setting/promoter-signup getPromoterSignup L258-266 - string - - -
GET /feature-setting/consumer-signup getConsumerSignup L273-281 - string - - -
GET /feature-setting/:featureName getPublicSetting L283-287 featureName: FeatureName - - - -

feture-flag

FeatureFlagController

📁 File: src/feture-flag/feature-flag.controller.ts

Base Path: feature-flag

Method Path Handler Location Params Query Body Return Type Description
GET /feature-flag/default/names getDefaultFeatureFlagNames L18-23 - - - - -
GET /feature-flag/registry getFeatureFlagRegistry L25-30 - - - - -
GET /feature-flag/ checkFeatureFlag L37-45 - CheckFeatureFlagRequest - - -
GET /feature-flag/user/:userId getUserFeatureFlags L51-55 userId: string - - - -

fingerprint

FingerprintController

📁 File: src/fingerprint/fingerprint.controller.ts

Base Path: fingerprint

Method Path Handler Location Params Query Body Return Type Description
POST /fingerprint/check-bot checkBot L30-94 - - CheckBotDto - -
POST /fingerprint/check-bot-public checkBotPublic L102-117 - - CheckBotDto - -

inbox

InboxController

📁 File: src/inbox/inbox.controller.ts

Base Path: inbox

Method Path Handler Location Params Query Body Return Type Description
GET /inbox/check-unread checkUnread L22-26 - - - - -
GET /inbox/ getMessages L28-42 - number - - -
PATCH /inbox/ markAllRead L44-49 - - - - -
PATCH /inbox/:messageId markRead L51-58 messageId: string - - - -

logging

LoggingController

📁 File: src/logging/logging.controller.ts

Base Path: logging

Method Path Handler Location Params Query Body Return Type Description
POST /logging/alert sendAlert L16-34 - - SendAlertDto - -
GET /logging/exception/:requestId exception L36-56 requestId: string - - - -
GET /logging/exception/:requestId/related-requests getRelatedRequestsByException L58-176 requestId: string - - - -

map

MapAdminController

📁 File: src/map/map.admin.controller.ts

Base Path: map/admin

Method Path Handler Location Params Query Body Return Type Description
GET /map/admin/timezone getTimezoneByAddress L30-33 - GetTimeZoneByAddressRequest - - -

MapController

📁 File: src/map/map.controller.ts

Base Path: map

Method Path Handler Location Params Query Body Return Type Description
GET /map/timezone getTimezoneByAddress L9-12 - GetTimeZoneByAddressRequest - - -

marketplace

MarketplaceController

📁 File: src/marketplace/marketplace.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
POST /marketplace/products/search queryMarketProducts L20-37 - - MarketPlaceProductAndPagination - -

merchant

MerchantController

📁 File: src/merchant/merchant.controller.ts

Base Path: merchant

Method Path Handler Location Params Query Body Return Type Description
GET /merchant/:merchantId/self merchant L45-50 merchantId: string - - - -
GET /merchant/list list L52-59 - GetMerchantsRequest - - -
GET /merchant/:inviteCode/invitation-id getMerchantByInviteCode L61-68 inviteCode: string - - - -
PATCH /merchant/sync/:merchantId updateByAdmin L70-77 merchantId: string - UpdateMerchantByAdminRequest - -
PUT /merchant/:merchantId/return-policy updateReturnPolicy L79-87 merchantId: string - UpdateMerchantReturnPolicyRequest - -
POST /merchant/by-merchant createByMerchant L90-100 - - TCreateShopifyCredentialsByMerchantsParams - -
POST /merchant/ create L102-106 - - CreateMerchantRequest - -
GET /merchant/set-up createDefault L108-127 - - - - -
POST /merchant/shopify/create createShopifyMerchant L129-173 - - CreateShopifyMerchantRequestV2 - -
PUT /merchant/shopify/:merchantId updateShopifyMerchant L175-182 merchantId: string - CreateShopifyMerchantRequest - -
PUT /merchant/sync-shopify/:merchantId syncShopify L184-189 merchantId: string - - - -
GET /merchant/:id/detail getMerchantById L191-205 id: string - - - -
PUT /merchant/:merchantId update L207-215 merchantId: string - UpdateMerchantRequest - -
GET /merchant/:merchantId/order-quantity getOrderQuantity L217-224 merchantId: string - - Promise -
DELETE /merchant/:merchantId delete L226-256 merchantId: string - - Promise -
POST /merchant/:merchantId/from-address createAddress L258-266 merchantId: string - PureAddressRequest - -
DELETE /merchant/:merchantId/from-address deleteAddress L267-272 merchantId: string - - - -

merchant-promoter-association

AdminMerchantPromoterAssociationController

📁 File: src/merchant-promoter-association/admin.merchant-promoter-association.controller.ts

Base Path: promote-invitation/admin

Method Path Handler Location Params Query Body Return Type Description
DELETE /promote-invitation/admin/disconnect/merchant/:merchantId/promoter/:promoterId disconnectSingleUser L24-51 merchantId: string, promoterId: string - - - -
DELETE /promote-invitation/admin/disconnect/featured-merchant/:promoterId disconnect L53-60 promoterId: string - - - -
DELETE /promote-invitation/admin/disconnect/:promoterId disconnectAllPromotersFromMerchant L62-70 promoterId: string - - - -

MerchantPromoterAssociationController

📁 File: src/merchant-promoter-association/merchant-promoter-association.controller.ts

Base Path: promote-invitation

Method Path Handler Location Params Query Body Return Type Description
GET /promote-invitation/permission/check checkPermissionBeforeAcceptInvitation L54-64 - CheckPermissionBeforeAcceptInvitationRequest - - -
GET /promote-invitation/permission getAcceptInvitationPermission L66-84 - AcceptInvitationPermissionRequest - Promise -
PATCH /promote-invitation/merchant acceptInviteByMerchant L86-129 - - AcceptMerchantInvitationRequest - -
PATCH /promote-invitation/promoter acceptInviteByPromoter L131-179 - - AcceptPromoteInvitationRequest - -
GET /promote-invitation/:merchantId/association associationByMerchant L187-194 merchantId: string - - - -
GET /promote-invitation/:merchantId/associations getLinkedPromoters L196-201 merchantId: string - - - -
GET /promote-invitation/merchants getMerchantsByAssociation L203-209 - - - - -
GET /promote-invitation/admin/merchants getMerchantsByAssociationForAdmin L211-220 - string - - -
GET /promote-invitation/:promoterId/my-merchants listMyMerchantsForPromoter L222-259 promoterId: string - - Promise -
PUT /promote-invitation/:promoterId updateBatchForPromoter L261-308 promoterId: string - UpdateMerchantPromoterAssociationRequest[] - -

merchant-tools

MerchantToolsController

📁 File: src/merchant-tools/merchant-tools.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
POST /merchants/:merchantId/sync-start startSyncing L17-23 merchantId: string - - - -
POST /merchants/:merchantId/sync-stop stopSyncing L25-30 merchantId: string - - - -
GET /merchants/:merchantId/sync-status getSyncStatus L32-37 merchantId: string - - - -

merchant-user

MerchantUserController

📁 File: src/merchant-user/merchant-user.controller.ts

Base Path: merchantUser

Method Path Handler Location Params Query Body Return Type Description
GET /merchantUser/self merchant L31-35 - - - - -
PUT /merchantUser/phone-number bindPhoneNumber L37-74 - - ValidateCodeRequest - -

merchant/shippingOption

CatalogShippingOptionController

📁 File: src/merchant/shippingOption/catalog.shipping.option.controller.ts

Base Path: catalog/shipping-option

Method Path Handler Location Params Query Body Return Type Description
GET /catalog/shipping-option/ getCatalogShippingOptions L31-60 - string - - -
PUT /catalog/shipping-option/:id updateCatalogShippingOptions L62-79 id: string - UpdateCatalogShippingOptionRequest - -
GET /catalog/shipping-option/:catalogId/:id/count countCatalogShippingOptions L81-90 catalogId: string, id: string - - - -
DELETE /catalog/shipping-option/:id deleteCatalogShippingOption L92-114 id: string - - - -
POST /catalog/shipping-option/ createCatalogShippingOptions L116-130 - - CreateCatalogShippingOptionRequest - -

notification-settings

NotificationSettingsController

📁 File: src/notification-settings/notification-settings.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
GET /users/:userId/notification-settings getNotificationSenderEmail L31-35 userId: string - - - -
PUT /users/:userId/notification-settings/sender-email updateNotificationSenderEmail L37-44 - - UpdateSenderEmailRequest - -
POST /users/:userId/notification-settings/sender-email/resend resendVerificationSenderEmail L46-64 - - - - -
POST /users/:userId/notification-settings/sender-email/confirm syncVerificationSenderEmail L66-79 - - SyncSenderEmailRequest - -

official-collections

OfficialCollectionsAdminController

📁 File: src/official-collections/official-collections-admin.controller.ts

Base Path: /admin/official-collections

Method Path Handler Location Params Query Body Return Type Description
GET /admin/official-collections/ listCollections L36-41 - - - - -
POST /admin/official-collections/ createCollection L43-46 - - CreateOfficialCollectionRequest - -
PUT /admin/official-collections/ updateCollections L48-51 - - UpdateOfficialCollectionsRequest - -
PUT /admin/official-collections/:collectionId updateCollection L53-62 collectionId: string - UpdateOfficialCollectionRequest - -
DELETE /admin/official-collections/:collectionId deleteCollection L64-67 collectionId: string - - - -
GET /admin/official-collections/:collectionId/products listCollectionProducts L69-85 collectionId: string QueryOfficialCollectionProductsRequest - - -
POST /admin/official-collections/:collectionId/products addCollectionProducts L87-96 collectionId: string - AddOfficialCollectionProductRequest - -
PUT /admin/official-collections/:collectionId/sort sortCollectionProducts L98-107 collectionId: string - SortOfficialCollectionProductRequest - -
DELETE /admin/official-collections/:collectionId/products deleteCollectionProduct L109-118 collectionId: string - DeleteOfficialCollectionProductRequest - -

OfficialCollectionsController

📁 File: src/official-collections/official-collections.controller.ts

Base Path: official-collections

Method Path Handler Location Params Query Body Return Type Description
GET /official-collections/ officialCollections L29-45 - - - - -
GET /official-collections/:vanityUrl/products officialCollectionDetail L47-69 vanityUrl: string PaginationInfo - - -

payment

PaymentController

📁 File: src/payment/payment.controller.ts

Base Path: payment

Method Path Handler Location Params Query Body Return Type Description
POST /payment/paypal/intent createPaypalIntent L33-45 - - CreatePayPalIntentRequest - -
POST /payment/stripe/setup-intent createStripeSetupIntent L47-51 - - - - -
POST /payment/stripe/customer createStripeCustomer L53-59 - - - - -
POST /payment/method addPaymentMethod L61-76 - - AddPaymentMethodRequest - -
DELETE /payment/method deletePaymentMethod L78-84 - - DeletePaymentMethodRequest - -
GET /payment/methods listPaymentMethods L86-92 - - - Promise -

payout

PayoutController

📁 File: src/payout/payout.controller.ts

Base Path: payout

Method Path Handler Location Params Query Body Return Type Description
GET /payout/summary getPayoutSummary L43-52 - - - Promise -
GET /payout/whitelist whitelist L54-59 - - - - -
GET /payout/history getPayoutHistory L62-80 - number - - -
POST /payout/withdraw withdraw L82-125 - - CreatePayoutReq Promise -
POST /payout/withdraw/admin withdrawByAdmin L127-191 - - CreatePayoutByAdminReq - -
GET /payout/detail/:id getDetail L194-199 id: string - - - -
DELETE /payout/method-bulk/:userId bulkDeleteWalletByAdmin L201-212 userId: string - DeletePayoutAccountReq - -

payout/payout-method

PayoutMethodController

📁 File: src/payout/payout-method/payout-method.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
POST /payout-methods/onboard onboardPayoutMethods L28-35 - - OnboardReq Promise -
GET /payout-methods listPayoutMethods L37-50 - - - Promise -
GET /payout-methods/:payoutMethodId/dashboard-url getPayoutMethodDashboardUrl L52-62 payoutMethodId: string - - Promise -
GET /payout-methods/:payoutMethodId/requirements-url getPayoutMethodRequirementsUrl L64-74 payoutMethodId: string - - Promise -
DELETE /payout-methods/:payoutMethodId deletePayoutMethod L76-80 payoutMethodId: string - - - -

payout/payout-review

PayoutReviewController

📁 File: src/payout/payout-review/payout-review.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
POST /payout-transactions/:id/approve approvePayoutTransaction L33-59 id: string - ApprovePayoutTransactionReq Promise -
POST /payout-transactions/:id/reject rejectPayoutTransaction L61-88 id: string - RejectPayoutTransactionReq Promise<PayoutTransactionRes null> -

payout/payout-transaction

PayoutTransactionController

📁 File: src/payout/payout-transaction/payout-transaction.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
GET /users/me/payout-transactions queryPayoutTransactionsByUser L43-76 - QueryPlainPayoutTransactionsReq - Promise -
GET /users/me/payout-transactions/:id getPayoutTransactionByUser L78-100 id: string - - Promise -
GET /payout-transactions queryPayoutTransactions L102-121 - QueryPayoutTransactionsReq - Promise -
GET /payout-transactions/:id getPayoutTransaction L123-142 id: string - - Promise -

periodic-notification

PeriodicNotificationController

📁 File: src/periodic-notification/periodic-notification.controller.ts

Base Path: periodic-notification

Method Path Handler Location Params Query Body Return Type Description
POST /periodic-notification/trigger/single sendManualReport L25-35 - - TriggerSingleRequest - -
POST /periodic-notification/trigger/previous trigger L43-52 - - TriggerPreviousRequest - -

posts

PostsController

📁 File: src/posts/posts.controller.ts

Base Path: posts

Method Path Handler Location Params Query Body Return Type Description
GET /posts/view getPostLiteDetail L35-102 - GetPostDetailRequest - Promise -
GET /posts/:id/style-settings getPostCustomizeTheme L104-108 id: string - - - -

posts/admin

PostAdminController

📁 File: src/posts/admin/posts.admin.controller.ts

Base Path: posts/admin

Method Path Handler Location Params Query Body Return Type Description
GET /posts/admin/products/financial-info getPostRelatedProductsFinancialInfoByAdmin L69-114 - string[] - - -
GET /posts/admin/v2/:id/relate-products getPostRelateProductsByAdminV2 L135-230 id: string - - Promise< 
Pick<
  PostType,
  | 'relatedProducts'
  | 'canSetPrice'
  | 'canConfigResale'
  | 'financeMode'
  | 'financeModeForPromoters'
> & {
  parentPost?: Pick<
    PostType,
    | 'allowPromotersResell'
    | 'allowPromotersSetPrice'
    | 'financeMode'
    | 'financeModeForPromoters'
  >;
  resalePostCount: number;
  permission: PostAdminPermissionFlags;
}

| - | | GET | /posts/admin/:id/catalog | getCatalogForPostByAdmin | L232-247 | id: string | MarketPlaceProductAndPagination | - | - | - | | PUT | /posts/admin/:id/dtc-partner/price | updateDTCPartner | L253-275 | id: string | - | AdminUpdateDTCPartnerPostRequest | - | - | | PUT | /posts/admin/:id/apply-rates-to-resale-posts | applyRatesToResalePosts | L309-317 | id: string | - | - | Promise<{ updatedPostCount: number; affectedPostIds: string[]; }> | - | | PUT | /posts/admin/:id/sync-product/:productId | syncPostRelatedProduct | L341-360 | id: string, productId: string | - | - | - | - | | POST | /posts/admin/connect/all/:postId/f496b73c-bfff-4259-bc65-e5bb4b87fafe | addPostToAllPromoters | L362-365 | postId: string | - | - | - | - | | POST | /posts/admin/connect/:postId/f220c163-a343-46f9-9072-b84c090ec638 | addPostToPromoter | L367-373 | postId: string | - | string[] | - | - | | DELETE | /posts/admin/disconnect/all/:postId/9579af04-09a7-43e5-8b65-a5c34ed29f10 | deletePostFromAllPromoters | L375-378 | postId: string | - | - | - | - | | DELETE | /posts/admin/disconnect/:postId/044995bd-f3a5-4a51-80b6-aee35f1597fa | deletePostFromPromoters | L380-386 | postId: string | - | string[] | - | - | | POST | /posts/admin/preview-selling | previewSelling | L388-439 | - | - | PreviewSellingRequest | Promise | - |

posts/consumer

PostConsumerController

📁 File: src/posts/consumer/posts.consumer.controller.ts

Base Path: posts/consumer

Method Path Handler Location Params Query Body Return Type Description
GET /posts/consumer/lite-detail getPostLiteDetail L53-97 - GetPostDetailRequest - - -
GET /posts/consumer/detail getPostDetail L99-211 - GetPostDetailRequest - - -
GET /posts/consumer/related-shops listCustomerRelatedShops L230-253 - - - Promise -
GET /posts/consumer/simplify/list listSimplifyCustomerPosts L255-292 - GetPostListRequest - Promise -
GET /posts/consumer/simplify/:id simplifySingleCustomerPost L300-330 id: string - - Promise -

posts/curator

PostCuratorController

📁 File: src/posts/curator/posts.curator.controller.ts

Base Path: posts/curator

Method Path Handler Location Params Query Body Return Type Description
PUT /posts/curator/sorts sorts L100-104 - - SortPostRequest - Usability: shop owners can sort posts in their shop
PUT /posts/curator/:postId/pinned updatePostPin L111-130 postId: string - UpdatePostPinnedRequest - Usability: shop owners can pin a post to the top of their shop
GET /posts/curator/preview/:id previewPostById L137-145 id: string - - Promise -
POST /posts/curator/preview/create previewCreatePost L152-168 - - CreatePostRequest Promise -
POST /posts/curator/preview/update/:id previewUpdatePost L175-208 id: string - UpdateOriginalPostRequest Promise -
GET /posts/curator/edit/:id getPostForEdit L217-268 id: string - - Promise -
GET /posts/curator/duplicate/:id getPostForDuplicate L278-299 id: string - - - -
POST /posts/curator/copy/:id copyOthersPost L307-394 id: string - - - -
GET /posts/curator/duplicate/verify/:id verifyPostForDuplicate L396-444 id: string - - - -
POST /posts/curator/ createPost L446-458 - - CreatePostRequest - -
POST /posts/curator/from-event createEventPost L557-604 - - CreatePostRequest - -
PUT /posts/curator/:postId updatePost L606-768 postId: string - UpdateOriginalPostRequest - -
PUT /posts/curator/resell/:postId updateResellPost L770-924 postId: string - UpdateResellPostRequest - -
DELETE /posts/curator/:postId deletePost L926-931 postId: string - - - -
GET /posts/curator/catalog getCatalogForPost L933-944 - MarketPlaceProductAndPagination - Promise -
GET /posts/curator/new/alias generatePostAlias L946-953 - string - - -
GET /posts/curator/alias/:urlAlias/check checkPostAliasAvailable L955-964 urlAlias: string - - - -
GET /posts/curator/media/last-upload getLastUploadMedia L966-975 - GetLastUploadMediaRequest - - -
GET /posts/curator/:id/resell-count getPostResellCount L977-981 id: string - - - -
GET /posts/curator/shop listSimplify L983-1012 - GetPostListRequest - Promise -
GET /posts/curator/shop/:id simplifySingleLite L1014-1034 id: string - - Promise -
GET /posts/curator/promotion-selected/:merchantId getPostsByIds L1043-1061 merchantId: string GetPromotionSelectedPostRequest - Promise -
GET /posts/curator/merchant-product/:merchantId getPostsByMerchant L1070-1082 merchantId: string GetPostForPromotionRequest - - -
GET /posts/curator/alias/list getPostsForSplitTraffics L1090-1094 - - - - -
GET /posts/curator/popup/edu-first-post/check checkEduPopup L1096-1108 - - - - -
GET /posts/curator/ab-testing/:postId getABTestingPosts L1110-1113 postId: string - - - -
POST /posts/curator/verification/permission getVerificationPermission L1120-1142 - - PostVerificationPermissionRequest - -
GET /posts/curator/downline/:postId getDownlinePostsAndShops L1144-1154 postId: string - - Promise -
POST /posts/curator/delete/downstream deleteDownstreamPosts L1156-1170 - - DeleteDownstreamPostsRequest - -
POST /posts/curator/reset/downstream resetDownstreamPosts L1172-1202 - - ResetDownstreamPostsRequest - -
GET /posts/curator/:postId/related-products getPostRelatedProductsByPostId L1204-1234 postId: string GetRelatedProductsRequest - - -
GET /posts/curator/:postId/promoters/un-synced getPostUnSyncPromoters L1236-1251 postId: string QueryPostPromotersRequest - - -
POST /posts/curator/:postId/promoters/sync syncPromoters L1253-1265 postId: string - SyncPostToPromotersRequest - -
POST /posts/curator/:postId/promoters/sync-all syncAllPromoters L1267-1273 postId: string - - - -
GET /posts/curator/my-catalog/event/products getTicketProducts L1275-1279 - QueryTicketProductsForPostRequest - - -
GET /posts/curator/event/:eventId/posts getEventRelatedPosts L1291-1298 eventId: string - - - -
POST /posts/curator/toggle-sync toggleSync L1338-1382 - - ToggleSyncRequest - -
PUT /posts/curator/card/:postId updatePostCard L1384-1410 postId: string - UpdatePostCardRequest - -

posts/curator/event

PostsEventController

📁 File: src/posts/curator/event/posts.event.controller.ts

Base Path: posts/curator/event

Method Path Handler Location Params Query Body Return Type Description
POST /posts/curator/event/:eventId/duplicate/posts duplicateEventPosts L12-23 eventId: string - DuplicateEventPostsRequest - -

posts/curator/history

PostHistoryController

📁 File: src/posts/curator/history/posts.history.controller.ts

Base Path: posts/curator/history

Method Path Handler Location Params Query Body Return Type Description
POST /posts/curator/history/version-history addPostVersionHistory L31-44 - - PostVersionHistoryRequest - -
GET /posts/curator/history/version-history/list listPostVersionHistory L46-54 - string - - -
GET /posts/curator/history/version-history getPostVersionHistory L56-67 - string - - -
POST /posts/curator/history/auto-save addAutoSave L69-83 - - PostsAutoSaveRequest - -
GET /posts/curator/history/auto-save listAutoSave L85-106 - string - - -
DELETE /posts/curator/history/auto-save deleteAutoSave L108-112 - string - - -

posts/curator/theme

PostThemeController

📁 File: src/posts/curator/theme/posts.theme.controller.ts

Base Path: posts/curator/theme

Method Path Handler Location Params Query Body Return Type Description
POST /posts/curator/theme/ createTheme L28-35 - - PostThemeCreateRequest - -
GET /posts/curator/theme/list findThemes L37-41 - - - - -
PUT /posts/curator/theme/:id updateTheme L43-54 id: string - PostThemeUpdateRequest - -
DELETE /posts/curator/theme/:id deleteTheme L56-63 id: string - - - -

posts/promoter

PostPromoterController

📁 File: src/posts/promoter/posts.promoter.controller.ts

Base Path: posts/promoter

Method Path Handler Location Params Query Body Return Type Description
GET /posts/promoter/detail getPostDetail L68-90 - GetPostDetailRequest - - -
GET /posts/promoter/preview-store/post/detail getPreviewStorePostDetail L161-218 - GetPreviewPostDetailRequest - - -
POST /posts/promoter/resale createResalePost L225-244 - - CreateCuratorPostRequest - -
GET /posts/promoter/simplify/list listSimplifyCuratorPosts L251-276 - GetPostListRequest - Promise -
GET /posts/promoter/simplify/:id simplifySingleCuratorPost L283-314 id: string - - Promise -
GET /posts/promoter/shop shopSimplifyByVanityUrl L322-405 - GetPostListByVanityUrlRequest - Promise -
GET /posts/promoter/shop/:id singleSimplifyShopByVanityUrl L412-482 id: string string - Promise -
POST /posts/promoter/duplicate/resell/:id duplicateResellPost L491-503 id: string - DuplicateResellPostRequest - -

posts/promoter/customization

PostPromoterCustomizationController

📁 File: src/posts/promoter/customization/posts.customization.controller.ts

Base Path: posts/promoter/customization

Method Path Handler Location Params Query Body Return Type Description
POST /posts/promoter/customization/ create L26-48 - - PostsCustomizationRequest - -

product-event

ProductEventAdminController

📁 File: src/product-event/product.event.admin.controller.ts

Base Path: product-event/admin

Method Path Handler Location Params Query Body Return Type Description
GET /product-event/admin/:id/details getDetails L20-39 id: string - - - -
PATCH /product-event/admin/:id/status updateStatus L41-58 id: string - ProductEventUpdateStatusRequest - -

ProductEventController

📁 File: src/product-event/product.event.controller.ts

Base Path: product-event

Method Path Handler Location Params Query Body Return Type Description
POST /product-event/ create L53-57 - - ProductEventCreateRequest - -
PUT /product-event/:id update L59-66 id: string - ProductEventUpdateRequest - -
DELETE /product-event/:id delete L68-73 id: string - - - -
GET /product-event/list list L75-79 - ProductEventListRequest - - -
GET /product-event/:id/details getDetails L81-85 id: string - - - -
GET /product-event/:id/extra getEventExtraInfo L87-95 id: string - - - -
POST /product-event/verification/permission getVerificationPermission L97-117 - - EventVerificationPermissionRequest - -
GET /product-event/:eventId/customers getEventCustomers L119-137 eventId: string EventCustomerListRequest - - -
POST /product-event/event-message/sms sendSms L139-143 - - SendSmsRequest - -
POST /product-event/event-message/email sendEmail L145-149 - - SendEmailRequest - -
GET /product-event/event-message/sms getSendSmsInfo L151-163 - string - - -
GET /product-event/event-message/email getSendEmailInfo L165-177 - string - - -
GET /product-event/event-message/:eventId/history getEventMessages L179-188 eventId: string - - - -
GET /product-event/count count L190-194 - ProductEventCountRequest - - -
GET /product-event/:id/related-posts getRelatedPostsByEvent L196-203 id: string - - - -
GET /product-event/:id/has-existing-orders hasExistingOrders L205-208 id: string - - - -
GET /product-event/:id/address-info getAddressInfo L210-214 id: string - - - -
GET /product-event/:id/public-details getPublicDetails L216-220 id: string - - - -
GET /product-event/:id/view getEventView L222-226 id: string - - - -
GET /product-event/default-catalog getDefaultCatalog L233-247 - - - - -
GET /product-event/:eventId/metrics/promoters getEventPromoterMetrics L249-260 eventId: string PaginationInfo - - -
GET /product-event/:eventId/metrics/admin/promoters getEventPromoterMetricsForAdmin L262-275 eventId: string PaginationInfo - - -
GET /product-event/:eventId/metrics/summary getEventMetricsSummary L277-281 eventId: string - - - -
GET /product-event/:eventId/metrics/admin/summary getEventMetricsSummaryForAdmin L283-289 eventId: string - - - -
GET /product-event/:eventId/report getEventReport L291-295 eventId: string - - - -
GET /product-event/:eventId/admin/report getEventReportForAdmin L297-303 eventId: string - - - -
POST /product-event/customers/export exportEventCustomers L305-333 - - ExportEventCustomersRequest - -

product-event/guests/controllers

EventGuestController

📁 File: src/product-event/guests/controllers/event-guest.controller.ts

Base Path: event/:eventId/guests

Method Path Handler Location Params Query Body Return Type Description
POST /event/:eventId/guests/ addGuestsToEvent L35-42 eventId: string - AddGuestsToEventDto Promise -
GET /event/:eventId/guests/ getEventGuests L48-60 eventId: string EventGuestsQueryDto - - -
GET /event/:eventId/guests/stats getEventGuestStats L66-72 eventId: string - - Promise -
DELETE /event/:eventId/guests/batch removeGuestsFromEvent L79-91 eventId: string - RemoveGuestsFromEventDto Promise<{ removed: number }> -
GET /event/:eventId/guests/available getAvailableGuests L98-110 eventId: string GetGuestsQueryDto - - -

GuestGroupController

📁 File: src/product-event/guests/controllers/guest-group.controller.ts

Base Path: event/guest-groups

Method Path Handler Location Params Query Body Return Type Description
PUT /event/guest-groups/sorts sortGroups L35-40 - - SortGroupsDto Promise -
POST /event/guest-groups/ createGroup L46-52 - - CreateGroupDto Promise -
GET /event/guest-groups/ getMyGroups L58-62 - - - Promise -
GET /event/guest-groups/:id getGroupById L67-73 id: string - - Promise -
PUT /event/guest-groups/:id updateGroup L79-86 id: string - UpdateGroupDto Promise -
DELETE /event/guest-groups/:id deleteGroup L92-97 id: string - - Promise -
POST /event/guest-groups/:id/guests addGuestsToGroup L103-110 id: string - AddGuestsToGroupDto Promise<{ added: number; skipped: number }> -
DELETE /event/guest-groups/:groupId/guests removeGuestsFromGroup L116-124 groupId: string - string[] Promise -

GuestVerificationController

📁 File: src/product-event/guests/controllers/guest-verification.controller.ts

Base Path: event/guest-verification

Method Path Handler Location Params Query Body Return Type Description
POST /event/guest-verification/check-in checkInGuest L28-38 - - CheckInGuestDto Promise -
POST /event/guest-verification/uncheck-in uncheckInGuest L44-54 - - UncheckInGuestDto Promise -
GET /event/guest-verification/validate-token validateToken L61-74 - ValidateTokenQueryDto - Promise<{ hasTickets: boolean }> -
POST /event/guest-verification/detail getGuestDetail L76-83 - - GuestDetailRequest - -

GuestController

📁 File: src/product-event/guests/controllers/guest.controller.ts

Base Path: event/guests

Method Path Handler Location Params Query Body Return Type Description
POST /event/guests/ createGuest L39-43 - - CreateGuestDto Promise -
GET /event/guests/ getMyGuests L49-54 - GetGuestsQueryDto - - -
GET /event/guests/:id getGuestById L59-65 id: string - - Promise -
PUT /event/guests/:id updateGuest L70-77 id: string - UpdateGuestDto Promise -
DELETE /event/guests/batch batchDeleteGuests L83-88 - - BatchDeleteGuestsDto Promise -
POST /event/guests/batch-add-to-groups batchAddToGroups L94-99 - - BatchAddToGroupsDto - -

product-event/lineup

ProductEventLineUpController

📁 File: src/product-event/lineup/product.event.lineup.controller.ts

Base Path: product-event/:eventId/lineup

Method Path Handler Location Params Query Body Return Type Description
POST /product-event/:eventId/lineup/ createLineUp L16-23 eventId: string - CreateEventLineupRequest - -
PUT /product-event/:eventId/lineup/:lineupId update L25-33 eventId: string, lineupId: string - UpdateEventLineupRequest - -
DELETE /product-event/:eventId/lineup/:lineupId delete L35-46 eventId: string, lineupId: string - - - -
PUT /product-event/:eventId/lineup/top/:lineupId moveToTop L48-52 lineupId: string - - - -

product-event/v2

ProductEventV2Controller

📁 File: src/product-event/v2/product.event.v2.controller.ts

Base Path: product-event/v2

Method Path Handler Location Params Query Body Return Type Description
POST /product-event/v2/ createEvent L23-27 - - CreateEventV2Request - -
POST /product-event/v2/:eventId/media/batch/create createMedias L29-41 eventId: string - BatchCreateEventMediaRequest - -
POST /product-event/v2/:eventId/media/batch/operate operateMedias L43-55 eventId: string - BatchOperateEventMediaRequest - -
POST /product-event/v2/:eventId/ticket/batch/v2 createTicketsV2 L66-78 eventId: string - CreateEventTicketsRequest - -
POST /product-event/v2/:eventId/lineup/batch batchCreateLineups L80-92 eventId: string - BatchCreateLineupRequest - -
GET /product-event/v2/:eventId/config getEventConfig L94-103 eventId: string - - Promise -
GET /product-event/v2/:eventId/duplicate/config getEventDuplicateConfig L111-115 eventId: string - - - -
POST /product-event/v2/duplicate duplicateEvent L117-126 - - DuplicateEventRequest - -

product-reviews

ProductReviewsController

📁 File: src/product-reviews/product-reviews.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
GET /products/:productId/reviews queryProductReviews L13-27 productId: string QueryProductReviewsRequest - - -
GET /products/:productId/review-medias queryProductReviewMedias L29-43 productId: string QueryProductMediasRequest - - -

product-v2/controllers

ProductController

📁 File: src/product-v2/controllers/product.controller.ts

Base Path: v2/products

Method Path Handler Location Params Query Body Return Type Description
POST /v2/products/ createProduct L80-126 - - CreateProductV2Dto Promise -
GET /v2/products/:id getProduct L139-143 id: string - - Promise -
GET /v2/products/ listProducts L173-189 - ListProductsQueryDto - Promise<[ProductResponse[], number]> -
PUT /v2/products/:id updateProduct L203-257 id: string - UpdateProductV2Dto Promise -
DELETE /v2/products/:id deleteProduct L270-285 id: string - - Promise<{ message: string }> -

products/merchant-products

MerchantProductsController

📁 File: src/products/merchant-products/merchant-products.controller.ts

Base Path: merchant/product

Method Path Handler Location Params Query Body Return Type Description
GET /merchant/product/exist-product existProduct L106-115 - - - - -
GET /merchant/product/list list L162-183 - MerchantProductAndPagination - - -
GET /merchant/product/feature-count getFeatureCountWithMerchantProduct L185-196 - GetFeatureCountRequest - - -
GET /merchant/product/categories getCategories L198-202 - - - - -
GET /merchant/product/:productId getProduct L204-223 productId: string - - - -
GET /merchant/product/specific-by-merchant/:merchantId getProducts L225-236 merchantId: string string[] - - -
GET /merchant/product/association/images getImagesByProductIds L243-268 - string string[] - - -
GET /merchant/product/public/:productId/product-detail productDetailPublic L274-310 productId: string - - - -
GET /merchant/product/:productId/product-detail productDetail L316-349 productId: string - - - -
PUT /merchant/product/bulk bulkUpdate L351-370 - string UpdateMerchantProductPrivatePropertyRequest[] - -
PUT /merchant/product/connect/shop connectShopify L372-382 - - - - -
POST /merchant/product/ createProduct L384-412 - - CreateProductRequest - -
PUT /merchant/product/batch/shipping updateProductShippingBatch L414-479 - - BatchUpdateProductShippingRequest - -
PUT /merchant/product/:productId updateProduct L481-586 productId: string - UpdateProductRequest - -
PATCH /merchant/product/thirdPartProduct/:productId updateThirdPartProduct L588-601 productId: string - UpdateThirdPartProductRequest - -
PATCH /merchant/product/sync/:productId syncProduct L604-612 productId: string - TSyncPearProduct - -
DELETE /merchant/product/:productId deleteProduct L614-633 productId: string - - - -
POST /merchant/product/duplicate/:productId duplicateProduct L635-662 productId: string - - - -
GET /merchant/product/admin/list listThroughAdmin L668-689 - string - - -
POST /merchant/product/verification/permission getVerificationPermission L696-722 - - ProductVerificationPermissionRequest - -
GET /merchant/product/calculate/ticket calculateTicket L805-828 - CalculateTicketRequest - - -
POST /merchant/product/calculate/ticket/batch batchCalculateTicket L830-861 - - BatchCalculateTicketRequest - -
GET /merchant/product/media/last-product-images getLastProductImages L867-876 - GetLastProductImagesRequest - Promise -

products/promoter-products

PromoterProductController

📁 File: src/products/promoter-products/promoter-product.controller.ts

Base Path: promoter/product

Method Path Handler Location Params Query Body Return Type Description
POST /promoter/product/ create L73-82 - - CreatePromoterProductRequest Promise -
GET /promoter/product/ list L89-103 - PaginationInfo - Promise -
GET /promoter/product/public/:alias/product-detail getDetailPublic L111-181 alias: string PromoterByVanityUrlRequest - Promise -
GET /promoter/product/product-detail getDetail L188-221 - QueryPromoterProductRequest - Promise -
GET /promoter/product/:vanityUrl/shop promoterProducts L223-257 vanityUrl: string GetPromoterProductRequest - Promise -
GET /promoter/product/associations associations L263-272 - PaginationInfo - Promise -
GET /promoter/product/:merchantId/associations-merchant associationMerchant L274-285 merchantId: string MarketPlaceMerchantProductAndPagination - - -
GET /promoter/product/association-merchant-products associationMerchantProducts L287-298 - MarketPlaceProductAndPagination - - -
GET /promoter/product/videos listVideos L300-304 - VideoProductAndPagination - - -
DELETE /promoter/product/:id removeProduct L312-316 id: string - - - -
PATCH /promoter/product/revert/:id revert L318-322 id: string - - - -
PUT /promoter/product/ update L324-331 - - UpdatePromoterProduct - -
POST /promoter/product/image-url createImageUrl L333-336 - - CloudinaryFolderType - -
POST /promoter/product/image-url/768c3e3c-333d-47ff-868b-84e52fe26157 createImageUrlForAdmin L338-345 - - CloudinaryFolderType - -
DELETE /promoter/product/catalog-product/:productId deleteProduct L357-364 productId: string - - - -

products/promoter-products/collections

PromoterCollectionsController

📁 File: src/products/promoter-products/collections/promoter.collections.controller.ts

Base Path: promoter/collections

Method Path Handler Location Params Query Body Return Type Description
POST /promoter/collections/ create L43-50 - - CollectionByNameRequest - -
GET /promoter/collections/ list L52-59 - GetAllCollectionRequest - - -
GET /promoter/collections/:vanityUrl/shop collectionsByShop L61-71 vanityUrl: string - - - -
PATCH /promoter/collections/ updateCollections L73-83 - - { collections: TCollectionParams[] } - -
PATCH /promoter/collections/product updateProductToCollections L85-96 - - UpdateProductToCollectionRequest - -
PUT /promoter/collections/product/pinned updateProductPinToCollections L98-107 - - UpdateProductPinnedToCollectionRequest - -
DELETE /promoter/collections/:collectionVanityUrl delete L109-116 collectionVanityUrl: string - - - -
GET /promoter/collections/:collectionVanityUrl/products getCollectionProducts L118-138 collectionVanityUrl: string PaginationInfo - - -
GET /promoter/collections/public/:collectionVanityUrl/products getCollectionProductsFromPublic L140-167 collectionVanityUrl: string PaginationInfo - - -
GET /promoter/collections/:collectionVanityUrl/product/:promoterProductAlias getCollectionProductByPromoterProductAliasFromPublic L169-189 collectionVanityUrl: string, promoterProductAlias: string - - - -
PATCH /promoter/collections/:collectionVanityUrl updateCollection L191-202 collectionVanityUrl: string - UpdateCollectionRequest - -
PUT /promoter/collections/sort-product/:collectionVanityUrl sortCollectionProductWithRankingScore L203-214 collectionVanityUrl: string - SortCollectionProductRequest - -

promoter-association

AdminPromoterAssociationController

📁 File: src/promoter-association/admin.promoter-association.controller.ts

Base Path: promoter-association/admin

Method Path Handler Location Params Query Body Return Type Description
DELETE /promoter-association/admin/disconnect/curator/:curatorId/promoter/:promoterId disconnect L25-42 curatorId: string, promoterId: string - - - -
DELETE /promoter-association/admin/disconnect/:curatorId disconnectAll L44-63 curatorId: string - - - -

PromoterAssociationController

📁 File: src/promoter-association/promoter-association.controller.ts

Base Path: promoter-association

Method Path Handler Location Params Query Body Return Type Description
GET /promoter-association/curators listAssociatedCurators L55-63 - - - - -
GET /promoter-association/collabs/curators listCollaborationPartners L65-69 - - - Promise -
GET /promoter-association/collabs/promoters listCollaborationPromoters L71-84 - ListCollaborationPromotersRequest - Promise<[CollaborationPromoterResponse[], number]> -
GET /promoter-association/:id/detail findPromoterAssociationDetail L86-134 id: string - - Promise -
PUT /promoter-association/:id update L136-142 id: string - UpdatePromoterAssociationRequest - -
DELETE /promoter-association/curator/:curatorId disconnectWithCurator L144-160 curatorId: string - - - -
DELETE /promoter-association/promoter/:promoterId disconnectWithPromoter L162-177 promoterId: string - - - -
GET /promoter-association/check-association checkAssociationByVanityUrl L179-203 - string - Promise -
GET /promoter-association/check-association/:curatorVanityUrl checkAssociationByCuratorVanityUrl L205-221 curatorVanityUrl: string - - Promise -
POST /promoter-association/guest/affiliate-link createAffiliateLinkForGuest L228-283 - - GuestCreateAffiliateLinkRequest - -
POST /promoter-association/curator/affiliate-link createAffiliateLink L290-368 - - CuratorCreateAffiliateLinkRequest - -
GET /promoter-association/affiliate-promoters getPromoterAffiliateLink L395-441 - QueryAffiliateLinkRequest - - -
GET /promoter-association/admin/collaboration/partners adminListCollaborationPartners L444-451 - string - Promise -
GET /promoter-association/admin/collaboration/promoters adminListCollaborationPromoters L453-468 - ListCollaborationPromotersRequest - Promise<[CollaborationPromoterResponse[], number]> -
POST /promoter-association/affiliate-link/notification sendCreateAffiliateLinkNotification L558-583 - - AffiliateLinkCreateNotificationRequest - -
GET /promoter-association/collabs/curator/:curatorId getCollaborationPartnerDetails L638-647 curatorId: string - - - -
PUT /promoter-association/:associationId/promoter updatePromoterAssociationByPromoter L649-661 associationId: string - UpdateAffiliateLinkByPromoterRequest - -

PromoterInvitationLinkController

📁 File: src/promoter-association/promoter-invitation-link/promoter-invitation-link.controller.ts

Base Path: promoter-invitation-link

Method Path Handler Location Params Query Body Return Type Description
POST /promoter-invitation-link/invitation-link createPromoterInvitationLink L32-53 - - CreatePromoterInvitationLinkRequest Promise -
PUT /promoter-invitation-link/invitation-link/:id updatePromoterInvitationLink L55-77 id: string - UpdatePromoterInvitationLinkRequest Promise -
DELETE /promoter-invitation-link/invitation-link/:id deletePromoterInvitationLink L79-100 id: string - - - -
GET /promoter-invitation-link/invitation-link findPromoterInvitationLinkList L102-145 - - - Promise< 
PromoterInvitationLinkResponse[]

| - | | GET | /promoter-invitation-link/:invitationCode/check | checkInvitationCode | L147-158 | invitationCode: string | - | - | - | - |

promoter-earning

PromoterEarningController

📁 File: src/promoter-earning/promoter.earning.controller.ts

Base Path: promoter-earning

Method Path Handler Location Params Query Body Return Type Description
GET /promoter-earning/summary earningSummary L19-26 - boolean - - -
GET /promoter-earning/history-self-listing earningSelfListing L28-43 - number - Promise<[EarningOrder[], number]> -
GET /promoter-earning/reward-history rewardHistory L45-60 - number - - -
GET /promoter-earning/history earning L62-73 - number - - -

promoter-subscription

PromoterSubscriptionController

📁 File: src/promoter-subscription/promoter-subscription.controller.ts

Base Path: promoter-subscription

Method Path Handler Location Params Query Body Return Type Description
POST /promoter-subscription/ subscribe L25-35 - - Subscribe - -
DELETE /promoter-subscription/following/:userId unfollow L37-44 userId: string - - - -
GET /promoter-subscription/ checkSubscription L46-50 - string - - -
GET /promoter-subscription/list listSubscription L52-69 - string - - -
GET /promoter-subscription/following listFollowing L71-84 - number - - -
GET /promoter-subscription/following/:userId getFollow L86-93 userId: string - - - -
GET /promoter-subscription/setting/:promoterId promoterSetting L95-105 promoterId: string string - - -

promotion

PromotionController

📁 File: src/promotion/promotion.controller.ts

Base Path: promotions

Method Path Handler Location Params Query Body Return Type Description
GET /promotions/merchant-coupon/:merchantId/:promotionId/detail getMerchantPromotionDetail L30-41 merchantId: string, promotionId: number - - - -
GET /promotions/merchant-coupon/:merchantId getMerchantPromotions L43-48 merchantId: string - - - -
POST /promotions/merchant-coupon/:merchantId createMerchantPromotion L50-62 merchantId: string - CreatePromotionsByMerchantRequest - -
PUT /promotions/merchant-coupon/:merchantId/:promotionId updateMerchantPromotion L64-77 merchantId: string, promotionId: string - CreatePromotionsByMerchantRequest - -
GET /promotions/new/applicable-code generatePromotionApplicableCode L79-82 - string - - -
GET /promotions/applicable-code/:applicableCode/check checkPromotionApplicableCode L84-94 applicableCode: string CheckApplicableCodeRequest - - -
POST /promotions/applicable-code-availability checkPromotionApplicableCodes L96-115 - - string - -
DELETE /promotions/:id deletePromotion L117-120 id: number - - - -

sales/fulfillment

FulfillmentController

📁 File: src/sales/fulfillment/fulfillment.controller.ts

Base Path: orders/fulfillment

Method Path Handler Location Params Query Body Return Type Description
POST /orders/fulfillment/webhook createFulfillment L58-77 - - ShopifyFulfillment - -
POST /orders/fulfillment/webhook/update updateFulfillment L79-98 - - ShopifyFulfillment - -
POST /orders/fulfillment/merchant/:merchantId/:orderNumber makeShipping L100-114 merchantId: string, orderNumber: string - MakeShippingRequest - -
PUT /orders/fulfillment/tracking/:orderId updateOrderTracking L116-127 orderId: string - UpdateOrderTrackingNumberRequest - -

sales/metrics

MetricsController

📁 File: src/sales/metrics/metrics.controller.ts

Base Path: order/metrics

Method Path Handler Location Params Query Body Return Type Description
POST /order/metrics/event/:eventId/orders getEventOrders L38-50 eventId: string - EventMetricsQueryDto - -
POST /order/metrics/event/:eventId/summary getEventSummary L59-66 eventId: string - BaseMetricsQueryDto Promise<EventSummaryEntity null> -
POST /order/metrics/catalog/:merchantId/orders getCatalogOrders L75-87 merchantId: string - BaseMetricsQueryDto - -
POST /order/metrics/catalog/:merchantId/summary getCatalogSummary L96-103 merchantId: string - BaseMetricsQueryDto Promise<EventSummaryEntity null> -
POST /order/metrics/post/:postId/orders getPostOrders L112-124 postId: string - BaseMetricsQueryDto - -
POST /order/metrics/post/:postId/summary getPostSummary L133-140 postId: string - BaseMetricsQueryDto Promise<EventSummaryEntity null> -
POST /order/metrics/catalog/:merchantId/statistics/merchant getSalesMetricsCatalogMerchant L157-169 merchantId: string - ProductStatisticsQueryDto Promise -
POST /order/metrics/catalog/:merchantId/statistics/promoters getSalesMetricsCatalogPromoter L186-198 merchantId: string - ProductStatisticsQueryDto Promise -
POST /order/metrics/post/:postId/statistics/merchant getSalesMetricsPostMerchant L215-227 postId: string - ProductStatisticsQueryDto Promise -
POST /order/metrics/post/:postId/statistics/promoters getSalesMetricsPostPromoter L244-256 postId: string - ProductStatisticsQueryDto Promise -

sales/orders

AdminOrdersController

📁 File: src/sales/orders/admin.orders.controller.ts

Base Path: admin/order

Method Path Handler Location Params Query Body Return Type Description
GET /admin/order/consumer/detail/:id getConsumerOrderDetailAdmin L16-31 id: string - - - -
GET /admin/order/promoter/detail/:promoterOrderId getPromoterOrderDetailAdmin L33-40 promoterOrderId: string - - - -
GET /admin/order/merchant/detail/:merchantOrderId getMerchantOrderDetailAdmin L42-47 merchantOrderId: string - - - -
GET /admin/order/merchant/detail/:merchantOrderId/v2 getMerchantOrderDetailAdminV2 L49-56 merchantOrderId: string - - - -

OrdersController

📁 File: src/sales/orders/orders.controller.ts

Base Path: order

Method Path Handler Location Params Query Body Return Type Description
GET /order/merchant getMerchantOrders L102-191 - GetMerchantOrdersRequest - - -
GET /order/merchant/fulfillment/count getFulfillmentCount L193-198 - - - - -
GET /order/merchant/:merchantId/detail/:orderNumber getMerchantOrderDetail L200-212 merchantId: string, orderNumber: string - - - -
GET /order/merchant/:merchantId/detail/:orderNumber/v2 getMerchantOrderDetailV2 L214-233 merchantId: string, orderNumber: string - - - -
GET /order/merchant/:merchantId/pdf/:orderNumber getMerchantOrderDetailOfPDF L235-247 merchantId: string, orderNumber: string - - - -
GET /order/promoter getPromoterOrders L249-262 - string - - -
GET /order/promoter/admin getPromoterOrdersAdmin L264-270 - string - - -
GET /order/merchant/admin getMerchantOrdersAdmin L272-278 - string - - -
GET /order/promoter/detail/:promoterOrderId getPromoterOrderDetail L280-289 promoterOrderId: string - - - -
GET /order/promoter/detail/:promoterOrderId/v2 getPromoterOrderDetailV2 L291-302 promoterOrderId: string - - Promise -
GET /order/consumer getConsumerOrders L304-315 - GetCartRequest - - -
GET /order/consumer/detail/:orderNumber getConsumerOrderDetail L317-328 orderNumber: string 'detail' 'confirmation' - - -
GET /order/guest/consumer/detail/:orderNumber getConsumerOrderDetailByGuest L336-354 orderNumber: string 'detail' 'confirmation' - - -
POST /order/ createOrder L356-452 - - CreateOrderRequest - -
PUT /order/admin/contact-info updateOrderContactInfo L454-459 - - UpdateOrderRequest - -
PUT /order/contact-info/:merchantId merchantUpdateOrderContactInfo L461-525 merchantId: string - UpdateOrderRequest - -
PUT /order/admin/cancel/:orderId cancelOrder L527-541 orderId: string - TPatchPartialRefundParams - -
GET /order/checkout getCheckout L543-620 - GetCheckoutRequest - - -
POST /order/checkout checkout L622-642 - - CheckoutBodyParams - -
POST /order/[/points-and-promotions, /promotions] updatePromotions L644-663 - - ApplyPromotionRequest - -
POST /order/buy-now buyNow L665-688 - - BuyNowRequest - -
POST /order/app/shopify/webhook/order/cancel cancelOrderWebhook L690-708 - - ShopifyOrderCanceledWebhookParams['data'] - -
POST /order/app/shopify/webhook/refund/create createRefundWebhook L710-728 - - ShopifyRefundCreatedWebhookParams['data'] - -
POST /order/admin/:orderId/confirmation-email/resend resendConfirmationEmailToConsumer L730-737 orderId: string - - - -
POST /order/admin/create-checkout adminCreateCheckout L764-792 - - AdminCreateCheckoutDto - -
POST /order/admin/create-order adminCreateOrder L819-866 - - AdminCreateOrderDto - -
POST /order/:merchantId/:orderId/confirmation-email/resend merchantResendConfirmationEmailToConsumer L868-896 merchantId: string, orderId: string - - - -
POST /order/ticket/status changeTicketStatus L903-932 - - TicketStatusChangeRequest - -
POST /order/:orderId/pickup-times submitPickupTimes L953-966 orderId: string - SubmitPickupTimesRequest - -
PUT /order/:merchantOrderId/pickup-time updatePickupTime L992-1004 merchantOrderId: string - UpdatePickupTimesRequest - -
POST /order/qr-redemption/status changeQrRedemptionStatus L1022-1066 - - qrRedemptionStatusChangeRequest - -

RefundController

📁 File: src/sales/orders/refund.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
POST /orders/:orderId/refunds createRefund L36-53 orderId: string - Omit - -
POST /merchant-orders/:merchantOrderId/refunds createMerchantOrderRefund L55-92 merchantOrderId: string - CreateRefundForMerchantReq - -
POST /orders/:orderId/suggest-refund suggestRefund L94-102 orderId: string - SuggestRefundReq - -
POST /merchant-orders/:merchantOrderId/suggest-refund suggestRefundForMerchant L104-132 merchantOrderId: string - SuggestRefundReq - -

sales/orders/verification

OrderVerificationController

📁 File: src/sales/orders/verification/order.verification.controller.ts

Base Path: order/verification

Method Path Handler Location Params Query Body Return Type Description
POST /order/verification/ verify L58-88 - - TicketVerificationReq - -
POST /order/verification/ticket/status changeTicketStatus L90-103 - - TicketChangeStatusReq - -
POST /order/verification/qr-redemption/status changeQRRedemptionStatus L110-122 - - QRRedemptionChangeStatusReq - -
GET /order/verification/has-tickets hasTickets L124-129 - TokenRequest - - -
GET /order/verification/ticket/statistics getTicketStatistics L131-136 - TokenRequest - - -
GET /order/verification/search searchGuestsAndOrders L142-163 - GuestOrderSearchRequest - - -
POST /order/verification/detail getOrderDetail L165-176 - - OrderDetailRequest - -
GET /order/verification/ticket-integration-redemption-codes getRedemptionCodes L184-194 - GetRedemptionCodesRequest - - -

sales/shipping

AddressController

📁 File: src/sales/shipping/address.controller.ts

Base Path: address

Method Path Handler Location Params Query Body Return Type Description
GET /address/default getDefaultOrFirstShippingAddress L31-35 - - - - -
GET /address/:addressId getSingleAddress L38-49 addressId: string - - - -
GET /address/ getAllAddressForAUser L51-55 - - - - -
POST /address/ createAddress L57-64 - - AddressRequest - -
POST /address/verify verifyAddress L66-73 - - AddressRequest - -
PUT /address/:addressId updateAddressForUser L75-86 addressId: string - UpdateAddressRequest - -
DELETE /address/:addressId deleteAddress L88-92 addressId: string - - - -
PATCH /address/:addressId updateDefaultAddressForUser L94-103 addressId: string - - Promise -
GET /address/autocomplete/suggestions autocompleteAddress L106-110 - string - - -
GET /address/autocomplete/details/:placeId getAddressDetails L112-116 placeId: string - - - -

script

ScriptController

📁 File: src/script/script.controller.ts

Base Path: script

Method Path Handler Location Params Query Body Return Type Description
POST /script/admin/cleanDirtyDataOfProduct cleanDirtyDataOfProduct L23-28 - - - - -
POST /script/syncShopifyMetafields syncShopifyMetafields L30-38 - - SyncShopifyMetafieldsParams - -
POST /script/setReviewsProvider setReviewsProvider L40-51 - - { 
  merchantId: string;
  reviewProvider: KatanaReviewAPI.ReviewProviderName;
} | - | - |

| POST | /script/syncReviewsOnSchedule | syncReviewsOnSchedule | L53-58 | - | - | - | - | - | | POST | /script/fixBodyTextOfPost | fixBodyTextOfPost | L60-65 | - | - | - | - | - | | POST | /script/createOrderOnShopify | createOrderOnShopify | L67-74 | - | - | { merchantOrderIds: string[] } | - | - | | POST | /script/duplicateProductsFromShopifyToShopify | duplicateProductsFromShopifyToShopify | L76-90 | - | - | { from: { shopUrl: string; accessToken: string }; to: { merchantId: string; shopUrl: string; accessToken: string }; sleepSeconds?: number; } | - | - | | POST | /script/listVerificationEmailTemplates | listVerificationEmailTemplates | L92-101 | - | - | ListCustomVerificationEmailTemplatesCommandInput | - | - | | POST | /script/deleteVerificationEmailTemplate | deleteVerificationEmailTemplate | L103-112 | - | - | DeleteCustomVerificationEmailTemplateCommandInput | - | - | | POST | /script/createVerificationEmailTemplate | createVerificationEmailTemplate | L114-123 | - | - | CreateCustomVerificationEmailTemplateCommandInput | - | - | | POST | /script/updateVerificationEmailTemplate | updateVerificationEmailTemplate | L125-134 | - | - | UpdateCustomVerificationEmailTemplateCommandInput | - | - | | POST | /script/generateVercelEdgeConfig/ac34c4b6-8aa4-46c2-8fbf-fab2c54b8d98 | generateVercelEdgeConfig | L136-139 | - | - | - | - | - | | POST | /script/getEgconfigs | getEgconfigs | L141-145 | - | - | - | - | - | | POST | /script/createUserAffiliateCode | createUserAffiliateCode | L147-150 | - | - | - | - | - | | POST | /script/fillBackgroundSource | fillBackgroundSource | L152-155 | - | - | - | - | - | | POST | /script/syncDeletedStatusToMerchantPromoterAssociation | syncDeletedStatusToMerchantPromoterAssociation | L157-160 | - | - | - | - | - | | POST | /script/fixPostUplinePostList | fixPostUplinePostList | L162-167 | - | - | - | - | - | | POST | /script/fixPostFinaceMode | fixPostFinaceMode | L174-177 | - | - | - | - | - | | POST | /script/migrateMerchantLineItems | migrateMerchantLineItems | L179-184 | - | - | - | - | - | | POST | /script/fixShopifyAndDiscordSocialMedial | fixShopifyAndDiscordSocialMedial | L186-189 | - | - | - | - | - | | POST | /script/addValueToSyncStoreFrontModuleIds | addValueToSyncStoreFrontModuleIds | L191-194 | - | - | - | - | - | | POST | /script/convertTimezoneToJson | convertTimezoneToJson | L196-199 | - | - | - | - | - | | POST | /script/fillEventDisplayDate | fillEventDisplayDate | L201-204 | - | - | - | - | - | | POST | /script/fillOrderLineItemEventId | fillOrderLineItemEventId | L206-209 | - | - | - | - | - | | POST | /script/fixEventUTCDate | fixEventUTCDate | L216-219 | - | - | - | - | - | | POST | /script/fixTicketProductTransactionFee-1d796b86-cf69-4cb1-8d21-33c7b43a59da | fixTicketProductTransactionFee | L221-226 | - | - | - | - | - | | POST | /script/settleOrder | settleOrder | L228-233 | - | - | { userIds?: string[] } | - | - | | POST | /script/migrateExceptionLoggingRequestId | migrateExceptionLoggingRequestId | L252-258 | - | - | { preview?: boolean; batchSize?: number } | - | - | | POST | /script/backfillSoldQuantity | backfillSoldQuantity | L273-277 | - | - | { preview?: boolean } | - | - | | POST | /script/importProVenueEvents | importProVenueEvents | L299-311 | - | - | { curatorId: string; eventIds?: string[]; limit?: number; offset?: number; } | - | - | | POST | /script/migrateProductImageSource | migrateProductImageSource | L320-324 | - | - | - | - | - |

settlement

SettlementController

📁 File: src/settlement/settlement.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
POST /settle-order settleOrder L11-16 - - SettleOrderReq - -

settlement/config

SettlementConfigController

📁 File: src/settlement/config/settlement-config.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
GET /users/:userId/settlement-configs getSettlementConfigs L15-36 userId: string - - Promise -
POST /users/:userId/settlement-configs upsertSettlementConfigs L38-60 userId: string - UpsertSettlementConfigsReq - -

shop-admin

ShopAdminController

📁 File: src/shop-admin/shop-admin.controller.ts

Base Path: shop-admins

Method Path Handler Location Params Query Body Return Type Description
GET /shop-admins/my-shops getMyShops L100-110 - - - - -
POST /shop-admins/ createAdmin L132-157 - - CreateShopAdminDto - -
GET /shop-admins/ listAdmins L173-184 - ListShopAdminsDto - - -
GET /shop-admins/:id getAdminById L199-204 id: string - - - -
PUT /shop-admins/:id updateAdmin L225-239 id: string - UpdateShopAdminDto - -
POST /shop-admins/:id/suspend suspendAdmin L255-265 id: string - - - -
POST /shop-admins/:id/activate activateAdmin L281-291 id: string - - - -
DELETE /shop-admins/:id deleteAdmin L306-312 id: string - - Promise -
GET /shop-admins/me/context getMyContext L334-349 - - - - -

shopify

ShopifyController

📁 File: src/shopify/shopify.controller.ts

Base Path: shopify

Method Path Handler Location Params Query Body Return Type Description
POST /shopify/connecting-session createConnectingSession L50-58 - - CreateConnectingSessionReq - -
GET /shopify/connecting-session/:sessionId getConnectingSession L60-70 sessionId: string - - - -
GET /shopify/auth beginShopifyOAuth L72-104 - - - - -
GET /shopify/auth/callback shopifyOAuthCallback L106-186 - - - - -
POST /shopify/inventory-item/webhook/update updateProductWebhook L188-203 - - InstanceType - -
POST /shopify/inventory-item/webhook/create createProductWebhook L205-220 - - InstanceType - -

ShopifyWebhookController

📁 File: src/shopify/shopify.webhook.controller.ts

Base Path: shopify/admin/webhook

Method Path Handler Location Params Query Body Return Type Description
POST /shopify/admin/webhook/ addWebhooks L15-20 - - string - -
GET /shopify/admin/webhook/ listWebhooks L22-26 - string - - -
DELETE /shopify/admin/webhook/ deleteWebhooks L28-32 - - string - -

shopify-metafields

ShopifyVariantImagesController

📁 File: src/shopify-metafields/shopify-metafields.controller.ts

Base Path: shopify-variant-images

No endpoints found

shopify-variant-wiz

ShopifyVariantWizController

📁 File: src/shopify-variant-wiz/shopify-variant-wiz.controller.ts

Base Path: shopify-variant-wiz

No endpoints found

ShortLinkController

📁 File: src/short-link/short-link.controller.ts

Base Path: short-link

Method Path Handler Location Params Query Body Return Type Description
POST /short-link/ createShortLink L36-44 - - CreateGenericShortLinkRequest - -

sms

SmsController

📁 File: src/sms/sms.controller.ts

Base Path: sms

Method Path Handler Location Params Query Body Return Type Description
POST /sms/reply webhook L11-32 - - SmsWebHookRequest - -

sms/admin

SmsAdminController

📁 File: src/sms/admin/sms.admin.controller.ts

Base Path: sms/admin

Method Path Handler Location Params Query Body Return Type Description
POST /sms/admin/batch-send batchSendSms L31-46 - - BatchSendSmsRequest - -
GET /sms/admin/batch-status/:jobId getBatchStatus L48-64 jobId: string - - - -
POST /sms/admin/check-sms-permission checkSmsPermission L66-73 - - CheckSmsPermissionRequest - -

store-front/store-front

StoreFrontModuleController

📁 File: src/store-front/store-front/store-front-module.controller.ts

Base Path: store-front

Method Path Handler Location Params Query Body Return Type Description
PUT /store-front/ updateStoreFront L210-289 - - UpdateUserStoreFrontRequest - -
PUT /store-front/modules updateStoreFrontModules L296-355 - - UpdateStoreFrontModulesRequest Promise -
PUT /store-front/layout updateStoreLayout L366-414 - - UpdateStoreLayoutRequest Promise -
PUT /store-front/module-item/:moduleId updateModuleItems L416-446 moduleId: string - UpdateStoreFrontModuleItemRequest - -
GET /store-front/module/:id findModuleById L448-451 id: string - - - -
POST /store-front/module createStoreFrontModule L453-483 - - CreateStoreFrontModuleRequest - -
PUT /store-front/module/sort sortModule L485-489 - - SortStoreFrontModuleRequest - -
PUT /store-front/module/:id updateModule L491-510 id: string - UpdateStoreFrontModuleRequest - -
DELETE /store-front/module/:id removeModuleById L512-527 id: string - - - -
GET /store-front/shop/:vanityUrl findModulesForShop L529-561 vanityUrl: string ShopModuleRequest - Promise -
GET /store-front/catalog getCatalog L563-577 - StoreModuleCatelogRequest - Promise -
GET /store-front/posts listPosts L579-590 - - - Promise -
GET /store-front/:postId/post-related-products listPostRelatedProducts L592-637 postId: string - - - -
GET /store-front/consumer/:alias/product-detail getDetailPublic L645-767 alias: string PromoterByVanityUrlRequest - Promise -
GET /store-front/self/product-detail getDetailBySelf L774-836 - QueryPromoterProductRequest - Promise -
POST /store-front/theme createTheme L961-970 - - StoreFrontThemeCreateRequest Promise -
GET /store-front/theme/list findThemes L972-976 - - - Promise -
PUT /store-front/theme/:id updateTheme L978-989 id: string - StoreFrontThemeUpdateRequest Promise -
DELETE /store-front/theme/:id deleteTheme L991-998 id: string - - - -
DELETE /store-front/module-item/:id removeModuleItemById L1000-1004 id: string - - - -
GET /store-front/modules/by-type getModulesByType L1009-1015 - GetModulesByTypeRequest - - -
POST /store-front/sync-post-to-module autoSyncPostToModule L1020-1031 - - SyncPostToModuleRequest - -
POST /store-front/module-item/rearrange rearrangePostModuleItem L1033-1041 - - RearrangeModuleItemRequest - -

store-front/user-contact-form

UserContactFormController

📁 File: src/store-front/user-contact-form/user-contact-form.controller.ts

Base Path: user-contact-form

Method Path Handler Location Params Query Body Return Type Description
GET /user-contact-form/:userId/list findByUserId L48-58 userId: string UserContactFormListRequest - - -
GET /user-contact-form/:id findById L60-63 id: string - - - -
POST /user-contact-form/ createUserContactForm L65-75 - - CreateUserContactFormRequest - -
PUT /user-contact-form/sorts sorts L77-81 - - SortUserContactFormRequest - -
PUT /user-contact-form/:id updateById L83-98 id: string - UpdateUserContactFormRequest - -
GET /user-contact-form/public/:id findByIdPublic L100-120 id: string - - - -
DELETE /user-contact-form/:id removeById L122-133 id: string - - - -
POST /user-contact-form/submit submitInquiry L135-139 - - SendEmailMessageRequest - -
GET /user-contact-form/list/inquiry getCustomerInquiryCount L141-145 - GetCustomerInquiryRequest - - -
GET /user-contact-form/list/title getSimpleList L147-151 - - - - -
GET /user-contact-form/inquiry/export exportInquiries L153-192 - ExportInquiryRequest - - -
POST /user-contact-form/image-url generateImageSignature L206-216 - - PublicImageUploadRequest - -
GET /user-contact-form/inquiry/attachment/download customerInquiryDownload L227-240 - CustomerInquiryDownloadRequest - - -

UserLinkController

📁 File: src/store-front/user-link/user-link.controller.ts

Base Path: user-link

Method Path Handler Location Params Query Body Return Type Description
GET /user-link/:userId/list findByUserId L37-44 userId: string UserLinkListRequest - - -
GET /user-link/:id findById L46-49 id: string - - - -
POST /user-link/ createUserLink L51-101 - - CreateUserLinkRequest - -
PUT /user-link/sorts sorts L103-107 - - SortUserLinkRequest - -
PUT /user-link/:id updateById L109-139 id: string - UpdateUserLinkRequest - -
DELETE /user-link/:id removeById L141-149 id: string - - - -
POST /user-link/video-info getVideoInfo L151-156 - - VideoInfoRequest Promise<VideoInfoResponse null> -

subdomain

SubdomainController

📁 File: src/subdomain/subdomain.controller.ts

Base Path: subdomain

Method Path Handler Location Params Query Body Return Type Description
POST /subdomain/ createSubdomain L38-51 - - CreateSubdomainReq - -
GET /subdomain/user/:userId getSubdomainByUserId L54-59 userId: string - - - -
PUT /subdomain/:subdomainId updateSubdomain L62-79 subdomainId: string - UpdateSubdomainReq - -
DELETE /subdomain/:subdomainId deleteSubdomain L82-87 subdomainId: string - - - -
PUT /subdomain/user/:userId/:vanityUrl syncVantityUrlToVercel L90-101 userId: string, vanityUrl: string - - - -
POST /subdomain/tracking createSubdomainTracking L103-118 - - AdminCreateSubdomainAdPixelRequest - -
PUT /subdomain/tracking/:id updateSubdomainTracking L121-138 id: string - AdminUpdateSubdomainPixelRequest - -
DELETE /subdomain/tracking/:id deleteSubdomainTracking L141-157 id: string - AdminDeleteSubdomainPixelRequest - -

subscription-plan

SubscriptionPlanAdminController

📁 File: src/subscription-plan/subscription-plan-admin.controller.ts

Base Path: admin/subscription-plans

Method Path Handler Location Params Query Body Return Type Description
POST /admin/subscription-plans/ createSubscriptionPlan L34-55 - - CreateSubscriptionPlanRequest Promise -
GET /admin/subscription-plans/ listSubscriptionPlans L57-76 - QuerySubscriptionPlansRequest - Promise -
GET /admin/subscription-plans/:subscriptionPlanId getSubscriptionPlan L78-104 subscriptionPlanId: string - - Promise -
PUT /admin/subscription-plans/:subscriptionPlanId updateSubscriptionPlan L106-134 subscriptionPlanId: string - UpdateSubscriptionPlanRequest Promise -
DELETE /admin/subscription-plans/:subscriptionPlanId deleteSubscriptionPlan L136-143 subscriptionPlanId: string - - - -

SubscriptionPlanController

📁 File: src/subscription-plan/subscription-plan.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
GET /merchants/:merchantId/subscription-plans listSubscriptionPlans L37-58 merchantId: string QuerySubscriptionPlansRequest - Promise -
GET /merchants/:merchantId/subscription-plan/:subscriptionPlanId getSubscriptionPlan L60-92 merchantId: string, subscriptionPlanId: string - - Promise -
POST /merchants/:merchantId/subscription-plans createSubscriptionPlan L94-117 merchantId: string - CreateSubscriptionPlanRequest Promise -
PUT /merchants/:merchantId/subscription-plan/:subscriptionPlanId updateSubscriptionPlan L119-154 merchantId: string, subscriptionPlanId: string - UpdateSubscriptionPlanRequest Promise -
DELETE /merchants/:merchantId/subscription-plan/:subscriptionPlanId deleteSubscriptionPlan L156-170 merchantId: string, subscriptionPlanId: string - - - -

transaction-fee

TransactionFeeController

📁 File: src/transaction-fee/transaction-fee.controller.ts

Base Path: /

Method Path Handler Location Params Query Body Return Type Description
GET /transaction-fee/default getConsumerOrderDetailAdmin L11-17 id: string - - - -

user

UserController

📁 File: src/user/user.controller.ts

Base Path: user

Method Path Handler Location Params Query Body Return Type Description
PUT /user/vanityUrl/:vanityUrl updateVanityUrl L94-140 vanityUrl: string - - - -
GET /user/subdomain getSubdomains L148-164 - string - - -
GET /user/self getUserInfo L166-296 - GetUserInfoRequest - Promise< 
(TConsumerInfo | TPromoterInfo) & {
  merchantCount: number;
  hasPassword: boolean;
  notificationSettings: NotificationSetting | null;
}

| - | | GET | /user/vanity-url/:vanityUrl | getUserByVanityUrl | L298-322 | vanityUrl: string | - | - | - | - | | GET | /user/shop-info/:vanityUrl | getShopInfo | L324-341 | vanityUrl: string | - | - | - | - | | GET | /user/vanity-url/:vanityUrl/onboarding-info | getUserOnboardingInfo | L343-376 | vanityUrl: string | - | - | Promise | - | | GET | /user/vanity-url/:vanityUrl/check | checkVanityUrlAvailable | L378-387 | vanityUrl: string | - | - | - | - | | GET | /user/browse-history | browseHistory | L389-398 | - | PaginationInfo | - | - | - | | POST | /user/browse-history | createBrowseHistory | L400-404 | - | - | CreateConsumerBrowseHistoryRequest | - | - | | GET | /user/onboarding-shops | onboardingShops | L406-517 | - | - | - | - | - | | GET | /user/shop/following | getFollowedShops | L519-557 | - | PaginationInfo | - | - | - | | DELETE | /user/shop/browse-history | deleteBrowseHistory | L559-576 | - | - | DeleteBrowseHistoryRequest | - | - | | PUT | /user/profile | updateProfile | L579-640 | - | - | UpdateUserProfileRequest | - | - | | PUT | /user/recent-used-colors | updateRecentUsedColors | L642-655 | - | - | string[] | - | - | | PUT | /user/social | updateSocial | L658-669 | - | - | UpdateUserSocialRequest | - | - | | PUT | /user/business-operation | updateBusinessOperation | L672-718 | - | - | UpdateUserBusinessOperationRequest | - | - | | PUT | /user/brand-kit | updateBrandKit | L721-751 | - | - | UpdateUserBrandKitRequest | - | - | | PUT | /user/verified | updateUserVerified | L754-803 | - | - | UpdateUserVerifiedRequest | - | - | | PUT | /user/event-completion-strategy | setEventCompletionStrategy | L808-816 | - | - | EventCompletionStrategyRequest | - | - | | GET | /user/event-completion-strategy | getEventCompletionStrategy | L823-832 | - | - | - | - | - | | PUT | /user/events/global-tax | setEventGlobalTax | L837-847 | - | - | EventGlobalTaxRequest | - | - | | GET | /user/events/global-settings | getEventGlobalSettings | L852-865 | - | - | - | - | - |

user-activity

UserActivityAnalyticsController

📁 File: src/user-activity/user.activity.analytics.controller.ts

Base Path: analytics

Method Path Handler Location Params Query Body Return Type Description
POST /analytics/post/summary postTrackingPostSummary L32-119 - - TrackingPostStatisticsQuery - -
GET /analytics/post/statistic/:postId getTrackingPostStatistics L121-156 postId: string number - - -

UserActivityController

📁 File: src/user-activity/user.activity.controller.ts

Base Path: ua

Method Path Handler Location Params Query Body Return Type Description
POST /ua/web-exception logWebException L33-51 - - any - -
POST /ua/ createActivity L53-129 - - CreateUserActivityRequest - -

vercel

VercelConfigController

📁 File: src/vercel/vercel.config.controller.ts

Base Path: vercel/config

Method Path Handler Location Params Query Body Return Type Description
GET /vercel/config/list/subdomain listVercelConfigBySubdomain L27-34 - - - - -
GET /vercel/config/list/split-traffic listVercelConfig L36-43 - - - - -
GET /vercel/config/:key getVercelConfig L45-52 key: string - - - -
PATCH /vercel/config/:key upSertVercelConfig L54-64 key: string - any - -
DELETE /vercel/config/:key deleteVercelConfig L66-77 key: string - - - -

web-scraper

WebScraperController

📁 File: src/web-scraper/web-scraper.controller.ts

Base Path: web-scraper

Method Path Handler Location Params Query Body Return Type Description
POST /web-scraper/komi getKomiData L15-19 - - ScrapeUrlRequest Promise -
POST /web-scraper/linktr getLinkTreeLinks L21-27 - - ScrapeUrlRequest Promise -
POST /web-scraper/images getPageImages L29-32 - - ScrapeUrlRequest Promise -

web-scraper/admin

EventscraperAdminController

📁 File: src/web-scraper/admin/event-scraper.admin.controller.ts

Base Path: external-event-import/admin

Method Path Handler Location Params Query Body Return Type Description
POST /external-event-import/admin/:userId importEvent L50-79 userId: string - EventImportRequest - -

ExternalUserImportAdminController

📁 File: src/web-scraper/admin/external-user-import.admin.controller.ts

Base Path: external-user-import/admin

Method Path Handler Location Params Query Body Return Type Description
POST /external-user-import/admin/partner importPartner L26-29 - - ImportPartnerRequest - -
POST /external-user-import/admin/promoter importPromoter L31-34 - - ImportPromoterRequest - -

WebScraperAdminController

📁 File: src/web-scraper/admin/web-scraper.admin.controller.ts

Base Path: web-scraper/admin

Method Path Handler Location Params Query Body Return Type Description
POST /web-scraper/admin/komi/:userId getKomiData L22-28 userId: string - ScrapeUrlRequest - -
POST /web-scraper/admin/linktr/:userId getLinkTreeData L30-36 userId: string - ScrapeUrlRequest - -

results matching ""

    No results matching ""